Composite QR Code Creation

Esta página descreve a criação de todos os QR Codes disponíveis para o Pix Automático.

QR Code Composto

Este endpoint é usado na jornada 2 para criar um QR Code contendo o contrato de pagamento recorrente.

Requisição

POST 'https://apisandbox.delbank.com.br/baas/api/v1/pix/qrcode/recurrences'

Cabeçalhos

Nome	Descrição
x-delbank-api-key	Obrigatório. Chave da API

Parâmetros do Body

Nome	Tipo	Descrição
responseFormat	enum	Obrigatório. Formato esperado na resposta. Domínios: ONLY_PAYLOAD PAYLOAD_AND_QRCODE
city	string	Obrigatório. Nome da cidade (máx. 15 caracteres)
recurrenceId	string	Opcional. Identificador da recorrência (máx. 29 caracteres)
frequencyType	enum	Obrigatório. Tipo de frequência. Domínios: WEEKLY, MONTHLY, QUARTERLY, SEMIANNUAL, ANNUAL
recurrenceStartDate	string	Obrigatório. Data de início da recorrência (máx. 10 caracteres)
recurrenceEndDate	string	Opcional. Data de fim da recorrência (máx. 10 caracteres)
amount	number	Opcional. Valor da transação
minPayerMaxAmount	number	Opcional. Valor mínimo permitido para o valor máximo do pagador
beneficiary	object	Opcional. Objeto contendo informações do beneficiário
beneficiary.ispb	string	Opcional. Código ISPB do beneficiário
beneficiary.document	string	Obrigatório. Documento do beneficiário (CPF/CNPJ)
beneficiary.name	string	Obrigatório. Nome completo do beneficiário (máx. 140 caracteres)
debtor	object	Obrigatório. Objeto contendo informações do devedor
debtor.type	enum	Obrigatório. Tipo do documento do devedor. Domínios: NATURAL LEGAL
debtor.document	string	Obrigatório. Documento do devedor (CPF/CNPJ)
debtor.name	string	Obrigatório. Nome completo do devedor
contractNumber	string	Obrigatório. Número do contrato (máx. 35 caracteres)
contractDescription	string	Opcional. Descrição do contrato (máx. 35 caracteres)
retry	enum	Obrigatório. Se retentativas são permitidas. Domínios: NOT_ALLOWED ALLOWED
beneficiaryConciliationId	string	Obrigatório. ID de conciliação do recebedor

Corpo

{
  "responseFormat": "ONLY_PAYLOAD",
  "city": "São Paulo",
  "recurrenceId": "RR3822485720250615A1B2C3D4E5",
  "frequencyType": "MONTHLY",
  "recurrenceStartDate": "2025-06-29",
  "recurrenceEndDate": "2026-06-29",
  "amount": 150.75,
  "minPayerMaxAmount": 150.75,
  "beneficiary": {
    "ispb": "38224857",
    "document": "12345678000199",
    "name": "Tech Solutions LTDA"
  },
  "debtor": {
    "type": "NATURAL",
    "document": "12345678901",
    "name": "João da Silva"
  },
  "contractNumber": "CTX-987654321",
  "contractDescription": "Serviço de streaming premium",
  "retry": "NOT_ALLOWED",
  "beneficiaryConciliationId": "REC-998877"
}

Resposta

O status code 200 indica sucesso na transação.

Em caso de sucesso, o retorno terá os seguintes campos em formato JSON:

{
    "documentId": "01000000-3353-6e2c-12c9-08de9f179024",
    "qrCodeImageBase64": "iVBORw0KGgoAAAANSUhEUgAAASQAAAEkAQAAAACugnFBAAAD60lEQVR4nO2aSZLcMAwE8QP8/5f4AczKgrp7Dg475kBcWl5GElMOisRSgBz9H0fFl/pSv6UiIrvOz6rO6so895u/agZXqHOd0ZG6jj7Mwc8R5ateoyIzz83kss5laPZn3gfS4CJVEXVGsyp1zStpwXuZam22FlbbG3psxjap81trmaEh7/aBi9f4YRN3KWb7t+OHD92lOLTDWlmdyCTx4uj8GXOuUuXVPERpa+UVPeZYjTFuUTLACs7PCFNPhRRhsUd5TVMmF0xYLsvAeRM9skMp9pZ8lammrsgNoRyR0VuU5ozTaotJDOW0ILeoZ1XvUzK486eUGypYT+ywmX+N196njntqvoocskUGU5lej+lltihdNJACiUzy+IU8JjHBXqKcFeSmRLWwGY4k0j+wREmNecN1rttgeg3Weo1S9PXGBqzzqdZWr5JbVDBL/ZoH2kmd3f/ItdcphThEo7SjclegIq1Enmx1n2pypZKoNjed6PWcchimuEPhoo3jsrtUKAHhN1iiFGJRjUWiZ7rmHHu3KE+10JD4BvN27CPFLlEKJMQyDYxCGy0ka3xVmbepYruznJkinz1GR75t4j6lJWW2FOWOc6OIql5a7jo1Uog3sMRmwnrA+mOJIlO1Q25YlFU5x0/m36Eod3HPoHKywEVDKmPkFpUG0gUBdRNrSknO6A41it91ZhNNFOycwT60yXUK1ZjhcOcLqzMXnblEaaKeus3PzRWJSETHY6vXKYpvpL+rYEddzM/9siVq8pQUh6BJolR26cJ4iUpcV6tb7nqWu2T4bb21yWWK2WUYHa1NryXJXLFF0UBM4q28lT0fC6j4UEO3qehJ7uUzNrnnR7+ywnWqrTaCFmw7OUyHXSu+Rnm0ae63K6dwlYJsiy1qXJRaCffV6vKF5Al2O1S6M2aZrTnH0yLTSb666bcpBZL2qrYZUqjDTD39/vsUoY0WRsZUTWgiK6J3r/Y2hfZBy4YrATXusEV3MnKJsnvyAjXJgAhMI69qjeJ8CoBChPQkeGqVx4euU+5xuhDni0jwaTDddHmy1X3KDLEu3f8pvtQQlfOV065T6QKT3l04SaWLJt2PWqNouPoDZaIzKHl1g3qzlyjad2nB7YaUd5sS5VWV36fQFXKESHeiOh3s+EbZT813nXJKms+3HPSuE3eJJ1vdp1yKuz/W0+7kRfxRqbYomgWJEdI/z9l9IslnF+MyZaVIo4ePSJ2zouWstUbxvyzoQVFjyvKcXd2K3aTCnQK6UeV+OlF45OUaZaObdj+WWG4HxVsDXKcsz/J5gPRpvfEZ5a5TeIebP/MBvB13s0bx7lD/Pr7Ul/ol9Qcqzr7t6yFh6wAAAABJRU5ErkJggg==",
    "payloadBase64": "MDAwMjAxMjYxODAwMTRici5nb3YuYmNiLnBpeDUyMDQwMDAwNTMwMzk4NjU4MDJCUjU5MTNDT1JQT1JBVEVOQU1FNjAwOVNhbyBQYXVsbzYyMjUwNTIxdmNoYXJnZTFjMTFhNDU5NWMxODQ4ODA3MTAwMTRici5nb3YuYmNiLnBpeDI1NDlwaXgtaC5kZWxiYW5rLmNvbS5ici92MS9yZWMvdmNoYXJnZTFjMTFhNDU5NWMxODQ4NjMwNDBCODU",
    "recurrencePayloadJws": "eyJhbGciOiJQUzUxMiIsImtpZCI6IjE0NzhFNDZBMjI4RjE0RDA5OUQ3RjYxMUMxMUNGNjM3M0NBMDY0MDEiLCJ4NXQiOiJGSGprYWlLUEZOQ1oxX1lSd1J6Mk56eWdaQUUiLCJqa3UiOiJodHRwczovL3BpeC1oLmRlbGJhbmsuY29tLmJyL3YyL2p3a3MiLCJ0eXAiOiJKV1QifQ.eyJpZFJlYyI6IlJSMzgyMjQ4NTcyMDI2MDQyMDBhMWQzYTJhMmQwIiwidmluY3VsbyI6eyJvYmpldG8iOiJDb250YSBkZSBlbmVyZ2lhIiwiZGV2ZWRvciI6eyJjcGYiOiI4NjgyOTUwMzA4NiIsIm5vbWUiOiJDb250YSBUZXN0ZSAwMiJ9LCJjb250cmF0byI6IjEyMzQ1Njc4OTBBQkMifSwiY2FsZW5kYXJpbyI6eyJkYXRhSW5pY2lhbCI6IjIwMjQtMTAtMjEiLCJkYXRhRmluYWwiOiIyMDI1LTExLTI0IiwicGVyaW9kaWNpZGFkZSI6Ik1FTlNBTCJ9LCJ2YWxvciI6eyJ2YWxvclJlYyI6IjEwLjAwIn0sInJlY2ViZWRvciI6eyJjbnBqIjoiMDMyODQ1ODQwMDAxNjIiLCJub21lOiJDT1JQT1JBVEVOQU1FIiwiaXNwYlBhcnRpY2lwYW50ZSI6IjM4MjI0ODU3In0sInBvbGl0aWNhUmV0ZW50YXRpdmEiOiJQRVJNSVRFXzNSXzdEIiwiYXR1YWxpemFjYW8iOlt7InN0YXR1cyIOiJDUklBREEiLCJkYXRhIjoiMjAyNi0wNC0yMFQyMDowMTowOC40NTNaIn1dfQ.rqypmJPU1k3EKZ-6GOKl4QjwsLV0mKn3TnmIH_Xcm1CGjBOq1CMIPtILmxp0ULUcT-7oBqZ7sgGbx8I5Uvtx1RzgBX7P8yL95VDs_cgEhqDx53vfLKZ52ATsty9Flu5x0aVE6hfYMqdk37Ffjw_vpuj7Ph32e0KHAIsTIV1QrDu9fiXraas3rNNollrSKcfhv1br6aoNy3zq61R9XmcgdAzqQ6yPqxv01_XjTDrQUmm9uP7kF0gBQ7iBnc-uemJGTtDRza8vLNlRJwJ1WcT3nCuYZVV5-1kmjWX9pQZXh_wW0S1_Ui9gomG71FsbmttjxqMT3HNMhGeqXXb7DgBZbg"
}

QR Code Composto Imediato

Este endpoint é usado na jornada 3 para criar um QR Code contendo o contrato de pagamento recorrente e um pagamento Pix inicial.

Requisição

POST 'https://apisandbox.delbank.com.br/baas/api/v1/pix/qrcode/recurrences/immediate-payment'

Cabeçalhos

Nome	Descrição
x-delbank-api-key	Obrigatório. Chave da API

Parâmetros do Body

Nome	Tipo	Descrição
responseFormat	enum	Obrigatório. Formato esperado na resposta. Domínios: ONLY_PAYLOAD PAYLOAD_AND_QRCODE (padrão)
key	string	Obrigatório. Chave Pix (máx. 77 caracteres)
categoryCode	string	Opcional. Código de categoria (máx. 4 caracteres). Padrão: 0000
payerRequest	string	Opcional. Mensagem exibida ao pagador (máx. 140 caracteres)
payerDocument	string	Opcional. Documento do pagador (CPF/CNPJ). Tamanho: 11 a 14 caracteres
payerName	string	Opcional. Nome do pagador (máx. 25 caracteres)
city	string	Obrigatório. Nome da cidade (máx. 15 caracteres)
zipCode	string	Opcional. CEP (máx. 99 caracteres)
originalAmount	number	Obrigatório. Valor original (máx. 12 dígitos inteiros, 2 casas decimais)
changeValue	enum	Opcional. Tipo de alteração de valor. Domínios: NOT_ALLOWED (padrão) ALLOWED
qrExpiration	integer	Opcional. Expiração do QR Code (em segundos). Padrão: 86400
additionalData	array	Opcional. Lista de dados adicionais
additionalData.name	string	Obrigatório. Nome do dado adicional (máx. 100 caracteres)
additionalData.value	string	Obrigatório. Valor do dado adicional (máx. 400 caracteres)
reusable	boolean	Opcional. Indica se o QR Code é reutilizável. Padrão: false
recurrenceData	object	Obrigatório. Dados de recorrência
recurrenceData.recurrenceId	string	Opcional. ID da recorrência
recurrenceData.frequencyType	enum	Obrigatório. Tipo de frequência. Domínios: WEEKLY, MONTHLY, QUARTERLY, SEMIANNUAL, ANNUAL
recurrenceData.recurrenceStartDate	string	Obrigatório. Data de início da recorrência. Padrão: YYYY-MM-DD
recurrenceData.recurrenceEndDate	string	Opcional. Data de fim da recorrência
recurrenceData.beneficiary	object	Opcional. Informações do beneficiário
recurrenceData.debtor	object	Obrigatório. Informações do devedor
recurrenceData.amount	number	Opcional. Valor (máx. 18 dígitos inteiros, 2 casas decimais)
recurrenceData.minPayerMaxAmount	number	Opcional. Valor mínimo permitido para o valor máximo do pagador (máx. 18 dígitos inteiros, 2 casas decimais)
recurrenceData.contractNumber	string	Obrigatório. Número do contrato
recurrenceData.contractDescription	string	Opcional. Descrição do contrato
recurrenceData.retry	enum	Obrigatório. Se retentativas são permitidas. Domínios: NOT_ALLOWED ALLOWED
beneficiaryConciliationId	string	Opcional. ID de conciliação do recebedor

Corpo

{
  "responseFormat": "PAYLOAD_AND_QRCODE",
  "key": "e7c3d5f2-4a1b-4c3d-9d15-1b2c3d4e5f60",
  "categoryCode": "0000",
  "payerRequest": "Pagamento recorrente - assinatura",
  "payerDocument": "12345678901",
  "payerName": "Joao da Silva",
  "city": "Sao Paulo",
  "zipCode": "01311-000",
  "originalAmount": 100.01,
  "changeValue": "NOT_ALLOWED",
  "qrExpiration": 86400,
  "additionalData": [
    {
      "name": "OrderId",
      "value": "ORD-20260422-0001"
    }
  ],
  "reusable": false,
  "recurrenceData": {
    "frequencyType": "MONTHLY",
    "recurrenceStartDate": "2026-05-01",
    "recurrenceEndDate": "2027-05-01",
    "recurrenceId": "RR3822485720260422A1B2C3D4E5",
    "beneficiary": {
      "ispb": "38224857",
      "cnpj": "58769325000182",
      "name": "Tech Solutions LTDA"
    },
    "debtor": {
      "type": "NATURAL",
      "document": "12345678901",
      "name": "Joao da Silva"
    },
    "amount": 100.01,
    "minPayerMaxAmount": 100.01,
    "contractNumber": "CTX-987654321",
    "contractDescription": "Assinatura mensal",
    "retry": "NOT_ALLOWED"
  },
  "beneficiaryConciliationId": "REC-998877"
}

Resposta

O status code 200 indica sucesso na transação.

Em caso de sucesso, o retorno terá os seguintes campos em formato JSON:

{
  "documentId": "01000000-3353-6e2c-12c9-08de9f179024",
  "qrCodeImageBase64": "iVBORw0KGgoAAAANSUhEUgAAASQAAAEkAQAAAACugnFBAAAD60lEQVR4nO2aSZLcMAwE8QP8/5f4AczKgrp7Dg475kBcWl5GElMOisRSgBz9H0fFl/pSv6UiIrvOz6rO6so895u/agZXqHOd0ZG6jj7Mwc8R5ateoyIzz83kss5laPZn3gfS4CJVEXVGsyp1zStpwXuZam22FlbbG3psxjap81trmaEh7/aBi9f4YRN3KWb7t+OHD92lOLTDWlmdyCTx4uj8GXOuUuXVPERpa+UVPeZYjTFuUTLACs7PCFNPhRRhsUd5TVMmF0xYLsvAeRM9skMp9pZ8lammrsgNoRyR0VuU5ozTaotJDOW0ILeoZ1XvUzK486eUGypYT+ywmX+N196njntqvoocskUGU5lej+lltihdNJACiUzy+IU8JjHBXqKcFeSmRLWwGY4k0j+wREmNecN1rttgeg3Weo1S9PXGBqzzqdZWr5JbVDBL/ZoH2kmd3f/ItdcphThEo7SjclegIq1Enmx1n2pypZKoNjed6PWcchimuEPhoo3jsrtUKAHhN1iiFGJRjUWiZ7rmHHu3KE+10JD4BvN27CPFLlEKJMQyDYxCGy0ka3xVmbepYruznJkinz1GR75t4j6lJWW2FOWOc6OIql5a7jo1Uog3sMRmwnrA+mOJIlO1Q25YlFU5x0/m36Eod3HPoHKywEVDKmPkFpUG0gUBdRNrSknO6A41it91ZhNNFOycwT60yXUK1ZjhcOcLqzMXnblEaaKeus3PzRWJSETHY6vXKYpvpL+rYEddzM/9siVq8pQUh6BJolR26cJ4iUpcV6tb7nqWu2T4bb21yWWK2WUYHa1NryXJXLFF0UBM4q28lT0fC6j4UEO3qehJ7uUzNrnnR7+ywnWqrTaCFmw7OUyHXSu+Rnm0ae63K6dwlYJsiy1qXJRaCffV6vKF5Al2O1S6M2aZrTnH0yLTSb666bcpBZL2qrYZUqjDTD39/vsUoY0WRsZUTWgiK6J3r/Y2hfZBy4YrATXusEV3MnKJsnvyAjXJgAhMI69qjeJ8CoBChPQkeGqVx4euU+5xuhDni0jwaTDddHmy1X3KDLEu3f8pvtQQlfOV065T6QKT3l04SaWLJt2PWqNouPoDZaIzKHl1g3qzlyjad2nB7YaUd5sS5VWV36fQFXKESHeiOh3s+EbZT813nXJKms+3HPSuE3eJJ1vdp1yKuz/W0+7kRfxRqbYomgWJEdI/z9l9IslnF+MyZaVIo4ePSJ2zouWstUbxvyzoQVFjyvKcXd2K3aTCnQK6UeV+OlF45OUaZaObdj+WWG4HxVsDXKcsz/J5gPRpvfEZ5a5TeIebP/MBvB13s0bx7lD/Pr7Ul/ol9Qcqzr7t6yFh6wAAAABJRU5ErkJggg==",
  "payloadBase64": "MDAwMjAxMjYxODAwMTRici5nb3YuYmNiLnBpeDUyMDQwMDAwNTMwMzk4NjU4MDJCUjU5MTNDT1JQT1JBVEVOQU1FNjAwOVNhbyBQYXVsbzYyMjUwNTIxdmNoYXJnZTFjMTFhNDU5NWMxODQ4ODA3MTAwMTRici5nb3YuYmNiLnBpeDI1NDlwaXgtaC5kZWxiYW5rLmNvbS5ici92MS9yZWMvdmNoYXJnZTFjMTFhNDU5NWMxODQ4NjMwNDBCODU",
  "recurrencePayloadJws": "eyJhbGciOiJQUzUxMiIsImtpZCI6IjE0NzhFNDZBMjI4RjE0RDA5OUQ3RjYxMUMxMUNGNjM3M0NBMDY0MDEiLCJ4NXQiOiJGSGprYWlLUEZOQ1oxX1lSd1J6Mk56eWdaQUUiLCJqa3UiOiJodHRwczovL3BpeC1oLmRlbGJhbmsuY29tLmJyL3YyL2p3a3MiLCJ0eXAiOiJKV1QifQ.eyJpZFJlYyI6IlJSMzgyMjQ4NTcyMDI2MDQyMDBhMWQzYTJhMmQwIiwidmluY3VsbyI6eyJvYmpldG8iOiJDb250YSBkZSBlbmVyZ2lhIiwiZGV2ZWRvciI6eyJjcGYiOiI4NjgyOTUwMzA4NiIsIm5vbWUiOiJDb250YSBUZXN0ZSAwMiJ9LCJjb250cmF0byI6IjEyMzQ1Njc4OTBBQkMifSwiY2FsZW5kYXJpbyI6eyJkYXRhSW5pY2lhbCI6IjIwMjQtMTAtMjEiLCJkYXRhRmluYWwiOiIyMDI1LTExLTI0IiwicGVyaW9kaWNpZGFkZSI6Ik1FTlNBTCJ9LCJ2YWxvciI6eyJ2YWxvclJlYyI6IjEwLjAwIn0sInJlY2ViZWRvciI6eyJjbnBqIjoiMDMyODQ1ODQwMDAxNjIiLCJub21lOiJDT1JQT1JBVEVOQU1FIiwiaXNwYlBhcnRpY2lwYW50ZSI6IjM4MjI0ODU3In0sInBvbGl0aWNhUmV0ZW50YXRpdmEiOiJQRVJNSVRFXzNSXzdEIiwiYXR1YWxpemFjYW8iOlt7InN0YXR1cyIOiJDUklBREEiLCJkYXRhIjoiMjAyNi0wNC0yMFQyMDowMTowOC40NTNaIn1dfQ.rqypmJPU1k3EKZ-6GOKl4QjwsLV0mKn3TnmIH_Xcm1CGjBOq1CMIPtILmxp0ULUcT-7oBqZ7sgGbx8I5Uvtx1RzgBX7P8yL95VDs_cgEhqDx53vfLKZ52ATsty9Flu5x0aVE6hfYMqdk37Ffjw_vpuj7Ph32e0KHAIsTIV1QrDu9fiXraas3rNNollrSKcfhv1br6aoNy3zq61R9XmcgdAzqQ6yPqxv01_XjTDrQUmm9uP7kF0gBQ7iBnc-uemJGTtDRza8vLNlRJwJ1WcT3nCuYZVV5-1kmjWX9pQZXh_wW0S1_Ui9gomG71FsbmttjxqMT3HNMhGeqXXb7DgBZbg"
}

QR Code Composto Estático

Este endpoint é usado na jornada 4 para criar um QR Code contendo o contrato de pagamento recorrente e um pagamento Pix inicial.

Requisição

POST 'https://apisandbox.delbank.com.br/baas/api/v1/pix/qrcode/recurrences/static'

Cabeçalhos

Nome	Descrição
x-delbank-api-key	Obrigatório. Chave da API

Parâmetros do Body

Nome	Tipo	Descrição
responseFormat	enum	Obrigatório. Formato esperado na resposta. Domínios: ONLY_PAYLOAD PAYLOAD_AND_QRCODE
key	string	Obrigatório. Chave Pix
categoryCode	string	Opcional. Código de categoria. Padrão: 0000
amount	number	Opcional. Valor (deve ser >= 0.00)
city	string	Obrigatório. Nome da cidade
zipCode	string	Opcional. CEP
beneficiaryConciliationId	string	Opcional. ID de conciliação do recebedor. Padrão: ***
additionalData	string	Opcional. Dados adicionais
ispbFss	string	Opcional. ISPB FSS
recurrenceData	object	Obrigatório. Dados de recorrência
recurrenceData.recurrenceId	string	Opcional. ID da recorrência
recurrenceData.frequencyType	enum	Obrigatório. Tipo de frequência. Domínios: WEEKLY, MONTHLY, QUARTERLY, SEMIANNUAL, ANNUAL
recurrenceData.recurrenceStartDate	string	Obrigatório. Data de início da recorrência. Padrão: YYYY-MM-DD
recurrenceData.recurrenceEndDate	string	Opcional. Data de fim da recorrência
recurrenceData.beneficiary	object	Opcional. Informações do beneficiário
recurrenceData.debtor	object	Obrigatório. Informações do devedor
recurrenceData.amount	number	Opcional. Valor (máx. 18 dígitos inteiros, 2 casas decimais)
recurrenceData.minPayerMaxAmount	number	Opcional. Valor mínimo permitido para o valor máximo do pagador (máx. 18 dígitos inteiros, 2 casas decimais)
recurrenceData.contractNumber	string	Obrigatório. Número do contrato
recurrenceData.contractDescription	string	Opcional. Descrição do contrato
recurrenceData.retry	enum	Obrigatório. Se retentativas são permitidas. Domínios: NOT_ALLOWED ALLOWED

Corpo

{
  "responseFormat": "PAYLOAD_AND_QRCODE",
  "key": "49907518093",
  "categoryCode": "0000",
  "amount": 550.00,
  "city": "Sao Paulo",
  "zipCode": "01311-000",
  "beneficiaryConciliationId": "REC-998877",
  "additionalData": "Informacao adicional do PSP do Recebedor",
  "ispbFss": "38224857",
  "recurrenceData": {
    "recurrenceId": "RR3822485720260422A1B2C3D4E5",
    "frequencyType": "ANNUAL",
    "recurrenceStartDate": "2026-05-01",
    "recurrenceEndDate": "2027-05-01",
    "beneficiary": {
      "ispb": "38224857",
      "cnpj": "58769325000182",
      "name": "Tech Solutions LTDA"
    },
    "debtor": {
      "type": "NATURAL",
      "document": "04623217035",
      "name": "Ciclano da Silva"
    },
    "amount": 550.00,
    "minPayerMaxAmount": 550.00,
    "contractNumber": "1234567890ABC",
    "contractDescription": "Conta de energia",
    "retry": "NOT_ALLOWED"
  }
}

Resposta

O status code 200 indica sucesso na transação.

Em caso de sucesso, o retorno terá os seguintes campos em formato JSON:

{
    "payloadBase64": "MDAwMjAxMjYzMzAwMTRici5nb3YuYmNiLnBpeDAxMTEwNTg3NjkzMjU4MjUyMDQwMDAwNTMwMzk4NjU0MDcxMTAwLjAxNTgwMkJSNTkyM0FsaXNzb24gT2xpdmVpcmEgTmV2ZXMgNjAwOVNhbyBQYXVsbzYxMDkwMTIyNy0yMDA2MjI1MDUyMXZjaGFyZ2U0YmYxMGQzNzljNTU0ZjgwNzEwMDE0YnIuZ292LmJjYi5waXgyNTQ5cGl4LWguZGVsYmFuay5jb20uYnIvdjEvcmVjL3ZjaGFyZ2U0YmYxMGQzNzljNTU0ZjYzMDQyOTFB",
    "payloadJwsRecorrencia": "eyJhbGciOiJQUzUxMiIsImtpZCI6IjJCQ0E4N0NCQUQyMDYwOEVGRDFCQzlCODA5QTU4RjExMEUxNUYyRTgiLCJ4NXQiOiJLOHFIeTYwZ1lJNzlHOG00Q2FXUEVRNFY4dWciLCJqa3UiOiJodHRwczovL3BpeC1oLmRlbGJhbmsuY29tLmJyL3YyL2p3a3MiLCJ0eXAiOiJKV1QifQ.eyJpZFJlYyI6IlJSMDQzNTg3OTgyMDI0MDYwNW5qdWE3c2hmNDBvIiwidmluY3VsbyI6eyJvYmpldG8iOiJDb250YSBkZSBlbmVyZ2lhIiwiZGV2ZWRvciI6eyJjcGYiOiIwNDYyMzIxNzAzNSIsImNucGoiOiIiLCJub21lIjoiQ2ljbGFubyBkYSBTaWx2YSJ9LCJjb250cmF0byI6IjEyMzQ1Njc4OTBBQkMifSwiY2FsZW5kYXJpbyI6eyJkYXRhSW5pY2lhbCI6IjIwMjQtMDEtMTAiLCJkYXRhRmluYWwiOiIyMDI2LTAxLTEwIiwicGVyaW9kaWNpZGFkZSI6IkFOVUFMIn0sInZhbG9yIjp7InZhbG9yTWluaW1vUmVjZWJlZG9yIjoiNTUwLjAwIn0sInJlY2ViZWRvciI6eyJjbnBqIjoiNTg3NjkzMjU4MiIsIm5vbWUiOiJBbGlzc29uIE9saXZlaXJhIE5ldmVzICIsImlzcGJQYXJ0aWNpcGFudGUiOiIzODIyNDg1NyJ9LCJwb2xpdGljYVJldGVudGF0aXZhIjoiUEVSTUlURV8zUl83RCIsImF0dWFsaXphY2FvIjpbeyJzdGF0dXMiOiJDUklBREEiLCJkYXRhIjoiMjAyNS0wNS0xM1QxODoyNzowOC45OThaIn1dfQ.gNyJtYD6if9spB91AT8vY__CqtOK6Yww3umwdVjKeP4SQqHdxr1hVMj0Iz5e328cjhaQA3krPcgeXRmOaS-CZyP2tUjvZ-6dpDe6KS8rWU5TNZwnI4LB2sL0dIDxT7lVE1YJ2RtcJrc_N-npnGy7x2jX4RSHNjmGi06347ufOBOV-OW_ycw3sNosFLyFIKzVl52ewT3ro4eEPvJfCkD8WKVwpypeKjvc1dwiBWm4CTQxj9soWkxcBxKD-dAppas15Ejq1aQlPA6WSsgVliC6e5W28QAy2ydxsuRnDlquxMTPbotZyp6lSZxlX7gtDmP8WTjhjX77iyJpfQyaQWeYNg"
}

QR Code Composto com Vencimento (Due Date)

Este endpoint é usado na jornada 4 para criar um QR Code contendo o contrato de pagamento recorrente e um pagamento Pix inicial.

Requisição

POST 'https://apisandbox.delbank.com.br/baas/api/v1/pix/qrcode/recurrences/due-date'

Cabeçalhos

Nome	Descrição
x-delbank-api-key	Obrigatório. Chave da API
x-delfinance-account-id	Obrigatório. O número da conta Delfinance

Parâmetros do Body

Nome	Tipo	Descrição
responseFormat	enum	Obrigatório. Formato esperado na resposta. Domínios: ONLY_PAYLOAD PAYLOAD_AND_QRCODE (padrão)
key	string	Obrigatório. Chave Pix (máx. 77 caracteres)
categoryCode	string	Opcional. Código de categoria (máx. 4 caracteres). Padrão: 0000
beneficiaryFantasyName	string	Opcional. Nome fantasia do recebedor (máx. 100 caracteres)
beneficiaryConciliationId	string	Opcional. ID de conciliação do recebedor. Tamanho: 26 a 35 caracteres
beneficiaryAddress	string	Obrigatório. Endereço do recebedor (máx. 150 caracteres)
city	string	Obrigatório. Nome da cidade (máx. 15 caracteres)
state	string	Obrigatório. UF. Tamanho: 2 caracteres
zipCode	string	Obrigatório. CEP (máx. 99 caracteres)
payerRequest	string	Opcional. Mensagem exibida ao pagador (máx. 140 caracteres)
payerDocument	string	Opcional. Documento do pagador (CPF/CNPJ). Tamanho: 11 a 14 caracteres
beneficiaryDocument	string	Opcional. Documento do recebedor (CPF/CNPJ). Tamanho: 11 a 14 caracteres
payerName	string	Obrigatório. Nome do pagador (máx. 200 caracteres)
originalAmount	number	Opcional. Valor original (máx. 12 dígitos inteiros, 2 casas decimais)
rebate	number	Opcional. Valor de abatimento (máx. 12 dígitos inteiros, 2 casas decimais)
discount	number	Opcional. Valor de desconto (máx. 12 dígitos inteiros, 2 casas decimais)
interest	number	Opcional. Valor de juros (máx. 12 dígitos inteiros, 2 casas decimais)
fine	number	Opcional. Valor de multa (máx. 12 dígitos inteiros, 2 casas decimais)
dueDate	string	Obrigatório. Data de vencimento. Padrão: YYYY-MM-DD
daysAfterDue	integer	Obrigatório. Dias após o vencimento. Máximo: 999999
additionalData	array	Opcional. Lista de dados adicionais
additionalData.name	string	Obrigatório. Nome do dado adicional (máx. 100 caracteres)
additionalData.value	string	Obrigatório. Valor do dado adicional (máx. 400 caracteres)
reusable	boolean	Opcional. Indica se o QR Code é reutilizável. Padrão: false
recurrenceData	object	Obrigatório. Dados de recorrência
recurrenceData.recurrenceId	string	Opcional. ID da recorrência
recurrenceData.frequencyType	enum	Obrigatório. Tipo de frequência. Domínios: WEEKLY, MONTHLY, QUARTERLY, SEMIANNUAL, ANNUAL
recurrenceData.recurrenceStartDate	string	Obrigatório. Data de início da recorrência. Padrão: YYYY-MM-DD
recurrenceData.recurrenceEndDate	string	Opcional. Data de fim da recorrência
recurrenceData.beneficiary	object	Opcional. Informações do beneficiário
recurrenceData.debtor	object	Obrigatório. Informações do devedor
recurrenceData.amount	number	Opcional. Valor (máx. 18 dígitos inteiros, 2 casas decimais)
recurrenceData.minPayerMaxAmount	number	Opcional. Valor mínimo permitido para o valor máximo do pagador (máx. 18 dígitos inteiros, 2 casas decimais)
recurrenceData.contractNumber	string	Obrigatório. Número do contrato
recurrenceData.contractDescription	string	Opcional. Descrição do contrato
recurrenceData.retry	enum	Obrigatório. Se retentativas são permitidas. Domínios: NOT_ALLOWED ALLOWED

Corpo

{
  "responseFormat": "PAYLOAD_AND_QRCODE",
  "key": "90343223007",
  "categoryCode": "0000",
  "beneficiaryFantasyName": "Tech Solutions",
  "beneficiaryConciliationId": "REC-998877-1234567890123456",
  "beneficiaryAddress": "Av. Paulista, 1000",
  "city": "Sao Paulo",
  "state": "SP",
  "zipCode": "01311-000",
  "payerRequest": "Pagamento recorrente - fatura",
  "payerDocument": "04623217035",
  "beneficiaryDocument": "58769325000182",
  "payerName": "Ciclano da Silva",
  "originalAmount": 550.00,
  "rebate": 0.00,
  "discount": 0.00,
  "interest": 0.00,
  "fine": 0.00,
  "dueDate": "2026-06-10",
  "daysAfterDue": 30,
  "additionalData": [
    {
      "name": "OrderId",
      "value": "ORD-20260422-0002"
    }
  ],
  "reusable": false,
  "recurrenceData": {
    "recurrenceId": "RR3822485720260422A1B2C3D4E5",
    "frequencyType": "MONTHLY",
    "recurrenceStartDate": "2026-06-10",
    "recurrenceEndDate": "2027-06-10",
    "beneficiary": {
      "ispb": "38224857",
      "cnpj": "58769325000182",
      "name": "Tech Solutions LTDA"
    },
    "debtor": {
      "type": "NATURAL",
      "document": "04623217035",
      "name": "Ciclano da Silva"
    },
    "amount": 550.00,
    "minPayerMaxAmount": 550.00,
    "contractNumber": "FAT-2026-06",
    "contractDescription": "Fatura recorrente",
    "retry": "NOT_ALLOWED"
  }
}

Resposta

O status code 200 indica sucesso na transação.

Em caso de sucesso, o retorno terá os seguintes campos em formato JSON:

{
  "documentId": "52c43361-caa1-4ddb-9152-708426a25db3",
  "qrCodeImageBase64": "iVBORw0KGgoAAAANSUhEUgAA...",
  "payloadBase64": "MDAwMjAxMjYxODAwMTRici5nb3YuYmNiLnBpeDUyMDQwMDAwNTMwMzk4NjU4MDJCUg==",
  "recurrencePayloadJws": "eyJhbGciOiJQUzUxMiIsImtpZCI6IjUwQTM5Qzc0MUE0RTFDQjQxN0Y2OEM2Q0MwMkY2M0JFOi4uLiJ9..."
}